Transition to API version 0.0.4 #6944

spell00 · 2020-09-01T19:10:30Z

Brief summary of changes

Transition to v0.0.4-dev to include new extensions of the API that are not in the current specs.
The changes include:

The specs of v0.0.3 is copied into v0.0.4-dev
The integration tests are changed to test v0.0.4-dev
All current endpoints allow v0.0.4-dev of the API

Link(s) to related issue(s)

Resolves [API] New version of the API (v0.0.4) #6941

spell00 · 2020-09-02T18:40:16Z

The version new name needs to be discussed.

modules/api/php/endpoints/candidate/visit/visit.class.inc

spell00 · 2020-09-16T15:12:26Z

@xlecours Could you please have a look at this?

xlecours

Could you add something in CHANGELOG.md to mention that there is a new version of the api specification in the modules section. We will add items under it for each new or changed endpoints.

…ndpoint

xlecours · 2020-09-18T18:07:56Z

@driusan This PR set the table for additional endpoints and modifications of existing endpoints. I will evaluate if the following PR can be include in v0.0.4
#6905
#6899
#6780
#6775
#6161
#5354

Meanwhile, I think this PR is the first step. Would you prefer to have a feature branch instead?

driusan

Since there's still other PRs to go into 0.0.4, please add the -dev suffix to the version number until it's ready. Otherwise we'll have multiple incompatible versions of "0.0.4".

Other than that it looks good to me.

xlecours · 2020-09-23T12:40:06Z

Since there's still other PRs to go into 0.0.4, please add the -dev suffix to the version number until it's ready. Otherwise we'll have multiple incompatible versions of "0.0.4".

Other than that it looks good to me.

@driusan it is not released.It is implicitly -dev. Otherwise, we would need to change all the 0.0.4 to 0.0.4-dev then back to 0.0.4 before the release.
And this is still v0

spell00 · 2020-09-29T17:15:58Z

@xlecours @driusan So what should it be? Is -dev because there is not a new version of the API at each release? How is it decided when it is time to remove the -dev suffix and start a new version? It's an easy and fast update to do, I wonder if updating the version systematically on each release wouldn't be faster and more straightforward, as it would avoid having a discussion on every release about removing or adding -dev?

Also, I thought it was implicitly -dev too, because it is v0. Wouldn't it make sense if all official new version of the API would update the first number (e.g. v0.0.4 -> v1.0.0) and all updates of the last number would be implicitely a dev version (e.g. v1.0.0 -> 1.0.1 -> 1.0.2)?

christinerogers · 2020-10-06T16:09:30Z

@driusan i think the naming is now resolved per today's loris meeting.
Could you please re-review?

This PR is holding up several other PRs that need to be merged in the next 2 weeks, plus key for the release.
cc @xlecours

…ating a visit with the correct visit

…ct". 0.0.2 is no longer supported.

spell00 · 2020-10-20T21:01:07Z

modules/api/docs/LorisRESTAPI_v0.0.4-dev.md

@@ -1,5 +1,4 @@
-# Loris API - v0.0.2


It looks like I modified a lot of things in the doc of v0.0.2, but it is actually modified from v0.0.3. I removed LorisRESTAPI.md and added LorisRESTAPI_v0.0.4-dev.md.

I did not modifiy the original LorisRESTAPI_v0.0.3.md so Github must consider I replaced v0.0.2 by v0.0.4-dev.

I solved this problem by renaming LorisRESTAPI_v0.0.3.md to LorisRESTAPI.md.

spell00 · 2020-10-20T21:03:02Z

modules/api/php/endpoints/candidate/visit/visit.class.inc

@@ -75,8 +75,10 @@ class Visit extends Endpoint implements \LORIS\Middleware\ETagCalculator
     */
    protected function supportedVersions() : array
    {
-        // Removed 0.0.2 since session requires a project.


this comment is no longer relevant, since 0.0.2 is no longer supported anywhere

spell00 · 2020-10-20T21:27:08Z

@driusan @xlecours as per our discussion this morning, I have removed support for v0.0.2 in all endpoints. I also removed the doc for v0.0.2.

I am not sure if @xlecours agreed with the use of the -dev suffixe, but I think we should proceed with this PR as it is (with -dev). If we were to decide to change the version to remove -dev, it is very fast to change it.

From the directory modules/api/php/endpoints/, I would just execute the command line:

grep -rli 'v0.0.4-dev' * | xargs -i@ sed -i 's/v0.0.4-dev/v0.0.4/g' @

cc @christinerogers

christinerogers · 2020-10-23T19:30:23Z

@xlecours @driusan could we get some joint attention on this PR? It's blocking the rest of Simon's work from moving forward, and this needs to be resolved in time.

xlecours · 2020-10-26T14:38:23Z

ok @driusan let's move forward.

Initiate development on version 0.0.4-dev of the API and remove support for 0.0.2 Resolves aces#6941

v0.0.2 was removed in aces#6944.

…e v0.0.3 (#7150) v0.0.2 support was removed in #6944. The CHANGELOG was also referencing the wrong pull request.

Initiate development on version 0.0.4-dev of the API and remove support for 0.0.2 Resolves aces#6941

…e v0.0.3 (aces#7150) v0.0.2 support was removed in aces#6944. The CHANGELOG was also referencing the wrong pull request.

spell00 force-pushed the 2020-09-01-NewApiVersion_0.0.4 branch from 801d93b to 72b1e96 Compare September 1, 2020 19:16

spell00 changed the title ~~2020 09 01 new api version 0.0.4~~ Transition to API version 0.0.4 Sep 1, 2020

spell00 added API PR or issue introducing/requiring modifications to the API code Blocking PR should be prioritized because it is blocking the progress of another task labels Sep 1, 2020

This was referenced Sep 1, 2020

Fix project instruments api #6929

Merged

[API] Added features for dicoms : PatientName and images: isPhantom #6899

Merged

[API] Add Project endpoint "Dicoms" #6775

Closed

spell00 requested a review from xlecours September 2, 2020 15:18

spell00 added the Discussion Required PR or issue awaiting the resolution of a discussion between all involved parties label Sep 2, 2020

xlecours requested changes Sep 3, 2020

View reviewed changes

modules/api/php/endpoints/candidate/visit/visit.class.inc Outdated Show resolved Hide resolved

spell00 requested a review from xlecours September 4, 2020 16:23

spell00 removed the Discussion Required PR or issue awaiting the resolution of a discussion between all involved parties label Sep 14, 2020

xlecours requested changes Sep 18, 2020

View reviewed changes

spell00 added 12 commits September 18, 2020 14:03

[API] Add getProjectID to candidatesrow model

c647baf

[API] Adding UserProjectMatch to candidates endpoint

ee86f35

[API] Candidates are now filtered by allowed project ids

fb96496

initial commit of transition to api v0.0.4

a10ae36

initial commit of transition to api v0.0.4

72ee8e8

[API] changes version in new spec document and removes other errors

3293105

[API] correct travis errors

eb2020d

[API] adds v0.0.4 in the supported versions of the /candidate dicom e…

caaa771

…ndpoint

[API] Removed version allowed in candidate visit added by mistake

06452c8

Remove new newlines at end of files

8d80df6

Remove new newlines at end of files

a2bb672

Announce of the new version of the API in CHANGELOG.md

e4e5061

spell00 force-pushed the 2020-09-01-NewApiVersion_0.0.4 branch from 6b6d928 to e4e5061 Compare September 18, 2020 18:04

Repairs errors introduced by mistake during rebase

da77b59

xlecours assigned driusan Sep 21, 2020

driusan requested changes Sep 22, 2020

View reviewed changes

spell00 mentioned this pull request Sep 29, 2020

Fixes the integration tests of the Candidate Instruments endpoints #7075

Merged

spell00 added 2 commits October 6, 2020 11:44

Changes v0.0.4 to v0.0.4-dev

3dc3d7d

New version v0.0.4-dev in CHANGELOG.md

5302c0c

spell00 requested a review from driusan October 6, 2020 15:51

christinerogers added the Critical to release PR or issue is key for the release to which it has been assigned label Oct 6, 2020

spell00 added 5 commits October 6, 2020 13:46

2020-09-01-NewApiVersion_0.0.4

1323272

The visit endpoint is modified for investigation and problem with cre…

62fa4c9

…ating a visit with the correct visit

Remove API v0.0.2 from supported versions

7cfc1df

Remove test for wrong PR

a72735a

Removed the line saying "Removed 0.0.2 since session requires a proje…

dd37eb7

…ct". 0.0.2 is no longer supported.

spell00 commented Oct 20, 2020

View reviewed changes

Chaning the name of API doc LorisRESTAPI_v0.0.3.md to LorisRESTAPI.md

d461679

driusan merged commit 7885224 into aces:main Oct 28, 2020

spell00 added a commit to spell00/Loris that referenced this pull request Nov 4, 2020

Transition to API version 0.0.4-dev (aces#6944)

41512bf

Initiate development on version 0.0.4-dev of the API and remove support for 0.0.2 Resolves aces#6941

ridz1208 added this to the 24.0.0 milestone Nov 27, 2020

driusan added a commit to driusan/Loris that referenced this pull request Nov 27, 2020

Update API version used by candidate_profile to be v0.0.3

a17337c

v0.0.2 was removed in aces#6944.

driusan mentioned this pull request Nov 27, 2020

[candidate_profile] Update API version used by candidate_profile to be v0.0.3 #7150

Merged

driusan added a commit that referenced this pull request Dec 3, 2020

[candidate_profile] Update API version used by candidate_profile to b…

6cd139c

…e v0.0.3 (#7150) v0.0.2 support was removed in #6944. The CHANGELOG was also referencing the wrong pull request.

AlexandraLivadas pushed a commit to AlexandraLivadas/Loris that referenced this pull request Jun 29, 2021

Transition to API version 0.0.4-dev (aces#6944)

5cd6f70

Initiate development on version 0.0.4-dev of the API and remove support for 0.0.2 Resolves aces#6941

ridz1208 mentioned this pull request Jul 8, 2021

[API] Incorrect or absent File name in endpoints /projects/{project}/images and /projects/{project}/recordings #6904

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Transition to API version 0.0.4 #6944

Transition to API version 0.0.4 #6944

spell00 commented Sep 1, 2020 •

edited

Loading

spell00 commented Sep 2, 2020

spell00 commented Sep 16, 2020

xlecours left a comment

xlecours commented Sep 18, 2020

driusan left a comment

xlecours commented Sep 23, 2020 •

edited

Loading

spell00 commented Sep 29, 2020

christinerogers commented Oct 6, 2020 •

edited

Loading

spell00 Oct 20, 2020

spell00 Oct 20, 2020

spell00 Oct 20, 2020

spell00 commented Oct 20, 2020

christinerogers commented Oct 23, 2020

xlecours commented Oct 26, 2020

Transition to API version 0.0.4 #6944

Transition to API version 0.0.4 #6944

Conversation

spell00 commented Sep 1, 2020 • edited Loading

Brief summary of changes

Link(s) to related issue(s)

spell00 commented Sep 2, 2020

spell00 commented Sep 16, 2020

xlecours left a comment

Choose a reason for hiding this comment

xlecours commented Sep 18, 2020

driusan left a comment

Choose a reason for hiding this comment

xlecours commented Sep 23, 2020 • edited Loading

spell00 commented Sep 29, 2020

christinerogers commented Oct 6, 2020 • edited Loading

spell00 Oct 20, 2020

Choose a reason for hiding this comment

spell00 Oct 20, 2020

Choose a reason for hiding this comment

spell00 Oct 20, 2020

Choose a reason for hiding this comment

spell00 commented Oct 20, 2020

christinerogers commented Oct 23, 2020

xlecours commented Oct 26, 2020

spell00 commented Sep 1, 2020 •

edited

Loading

xlecours commented Sep 23, 2020 •

edited

Loading

christinerogers commented Oct 6, 2020 •

edited

Loading